Skip to content

Docs: clarify community tool sharing#6460

Open
kmishra1204 wants to merge 1 commit into
crewAIInc:mainfrom
kmishra1204:docs/community-tool-sharing
Open

Docs: clarify community tool sharing#6460
kmishra1204 wants to merge 1 commit into
crewAIInc:mainfrom
kmishra1204:docs/community-tool-sharing

Conversation

@kmishra1204

@kmishra1204 kmishra1204 commented Jul 4, 2026 •
edited
Loading

Copy link
Copy Markdown

Summary

  • add guidance for sharing community-maintained CrewAI tool packages after publishing to PyPI
  • clarify that the package README should remain the primary source of truth
  • list the information maintainers can ask for when evaluating a docs mention

This addresses the documentation path question without adding a third-party tool catalog or documenting any one external package directly.

Closes #6458.

Validation

  • git diff --check -- docs/edge/en/guides/tools/publish-custom-tools.mdx

AI assistance / label note

  • AI assistance was used while drafting and reviewing this documentation-only change.
  • CrewAI's contributing guide says AI-assisted PRs require the llm-generated label. I attempted to apply it, but this account does not have label permission on the upstream repository.

@coderabbitai

coderabbitai Bot commented Jul 4, 2026 •
edited
Loading

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 9dc20906-0666-4517-bd44-444b31db90cf

📥 Commits

Reviewing files that changed from the base of the PR and between eede905 and cd90297.

📒 Files selected for processing (1)
  • docs/edge/en/guides/tools/publish-custom-tools.mdx
✅ Files skipped from review due to trivial changes (1)
  • docs/edge/en/guides/tools/publish-custom-tools.mdx
📝 Walkthrough

Walkthrough

This PR adds a new "Sharing Community Tools" documentation subsection to the custom tools publishing guide. It states that the package README should remain the primary reference and lists the information needed when requesting a docs mention for a community tool.

Changes

Documentation Update

Layer / File(s) Summary
Sharing Community Tools guidance
docs/edge/en/guides/tools/publish-custom-tools.mdx		 Adds guidance on using the README as the primary source of truth, what to include in a CrewAI docs mention request, and when to follow the normal contribution process for official crewai_tools inclusion.

Related issue: #6458

Compact Diff Overview: +18/-0 lines, low review effort.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title is concise and accurately reflects the docs change about clarifying community tool sharing.
Description check ✅ Passed The description matches the documentation-only change and explains the new community tool guidance.
Linked Issues check ✅ Passed The new guidance addresses the issue's question by defining the preferred docs path for externally published community tools.
Out of Scope Changes check ✅ Passed The PR stays within the requested documentation scope and adds no unrelated code or feature changes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@kmishra1204 kmishra1204 mentioned this pull request Jul 4, 2026
Closed
@kmishra1204

kmishra1204 commented Jul 4, 2026

Copy link
Copy Markdown
Author

I checked .github/CONTRIBUTING.md and saw the required llm-generated label for AI-assisted contributions. I tried to apply llm-generated, but GitHub returned a permissions error for AddLabelsToLabelable. I added a note to the PR body as well; maintainers, please apply the label if needed.

@kmishra1204 kmishra1204 force-pushed the docs/community-tool-sharing branch from eede905 to cd90297 Compare July 7, 2026 05:57
@kmishra1204

kmishra1204 commented Jul 7, 2026

Copy link
Copy Markdown
Author

Rebased this PR onto the current upstream main to clear the behind-base state.

Validation performed:

  • git diff --check upstream/main...HEAD
  • Confirmed the diff remains scoped to docs/edge/en/guides/tools/publish-custom-tools.mdx
  • CodeRabbit completed successfully after the rebase

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Docs: preferred way to list an externally-published community tool package (crewai-perseus-vault)?

1 participant

@kmishra1204